home *** CD-ROM | disk | FTP | other *** search
/ CD ROM Paradise Collection 4 / CD ROM Paradise Collection 4 1995 Nov.iso / arcers / tar316.zip / TREES.C < prev    next >
Text File  |  1994-06-28  |  40KB  |  1,046 lines
  1. /*
  2.  The following sorce code is derived from Info-Zip 'zip' 2.01
  3.  distribution copyrighted by Mark Adler, Richard B. Wales,
  4.  Jean-loup Gailly, Kai Uwe Rommel, Igor Mandrichenko and John Bush.
  5. */
  6.  
  7. /*
  8.  *  trees.c is initially written by Jean-loup Gailly
  9.  *
  10.  *  This is a new version of im_ctree.c originally written by Richard B. Wales
  11.  *  for the defunct implosion method.
  12.  *
  13.  *  PURPOSE
  14.  *
  15.  *      Encode various sets of source values using variable-length
  16.  *      binary code trees.
  17.  *
  18.  *  DISCUSSION
  19.  *
  20.  *      The PKZIP "deflation" process uses several Huffman trees. The more
  21.  *      common source values are represented by shorter bit sequences.
  22.  *
  23.  *      Each code tree is stored in the ZIP file in a compressed form
  24.  *      which is itself a Huffman encoding of the lengths of
  25.  *      all the code strings (in ascending order by source values).
  26.  *      The actual code strings are reconstructed from the lengths in
  27.  *      the UNZIP process, as described in the "application note"
  28.  *      (APPNOTE.TXT) distributed as part of PKWARE's PKZIP program.
  29.  *
  30.  *  REFERENCES
  31.  *
  32.  *      Lynch, Thomas J.
  33.  *          Data Compression:  Techniques and Applications, pp. 53-55.
  34.  *          Lifetime Learning Publications, 1985.  ISBN 0-534-03418-7.
  35.  *
  36.  *      Storer, James A.
  37.  *          Data Compression:  Methods and Theory, pp. 49-50.
  38.  *          Computer Science Press, 1988.  ISBN 0-7167-8156-5.
  39.  *
  40.  *      Sedgewick, R.
  41.  *          Algorithms, p290.
  42.  *          Addison-Wesley, 1983. ISBN 0-201-06672-6.
  43.  *
  44.  *  INTERFACE
  45.  *
  46.  *      int ct_init (void)
  47.  *          Allocate the match buffer and initialize the various tables.
  48.  *
  49.  *      int ct_tally(int dist, int lc);
  50.  *          Save the match info and tally the frequency counts.
  51.  *          Return true if the current block must be flushed.
  52.  *
  53.  *      long flush_block (char *buf, ulg stored_len, int eof)
  54.  *          Determine the best encoding for the current block: dynamic trees,
  55.  *          static trees or store, and output the encoded block to the zip
  56.  *          file. Returns the total compressed length for the file so far.
  57.  */
  58.  
  59. #include "modern.h"
  60. #include "zalloc.h"
  61. #include "zipdefs.h"
  62. #include "zipguts.h"
  63. #include "zippipe.h"
  64.  
  65. #define MAX_BITS 15
  66. /* All codes must not exceed MAX_BITS bits */
  67.  
  68. #define MAX_BL_BITS 7
  69. /* Bit length codes must not exceed MAX_BL_BITS bits */
  70.  
  71. #define LENGTH_CODES 29
  72. /* number of length codes, not counting the special END_BLOCK code */
  73.  
  74. #define LITERALS  256
  75. /* number of literal bytes 0..255 */
  76.  
  77. #define END_BLOCK 256
  78. /* end of block literal code */
  79.  
  80. #define L_CODES (LITERALS+1+LENGTH_CODES)
  81. /* number of Literal or Length codes, including the END_BLOCK code */
  82.  
  83. #define D_CODES   30
  84. /* number of distance codes */
  85.  
  86. #define BL_CODES  19
  87. /* number of codes used to transfer the bit lengths */
  88.  
  89. static int near extra_lbits[LENGTH_CODES] /* extra bits for each length code */
  90.    = {0,0,0,0,0,0,0,0,1,1,1,1,2,2,2,2,3,3,3,3,4,4,4,4,5,5,5,5,0};
  91.  
  92. static int near extra_dbits[D_CODES] /* extra bits for each distance code */
  93.    = {0,0,0,0,1,1,2,2,3,3,4,4,5,5,6,6,7,7,8,8,9,9,10,10,11,11,12,12,13,13};
  94.  
  95. static int near extra_blbits[BL_CODES]/* extra bits for each bit length code */
  96.    = {0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,0,2,3,7};
  97.  
  98. #define STORED_BLOCK 0
  99. #define STATIC_TREES 1
  100. #define DYN_TREES    2
  101. /* The three kinds of block type */
  102.  
  103. #ifndef LIT_BUFSIZE
  104. #  ifdef SMALL_MEM
  105. #    define LIT_BUFSIZE  0x2000
  106. #  else
  107. #  ifdef MEDIUM_MEM
  108. #    define LIT_BUFSIZE  0x4000
  109. #  else
  110. #    define LIT_BUFSIZE  0x8000
  111. #  endif
  112. #  endif
  113. #endif
  114. #define DIST_BUFSIZE  LIT_BUFSIZE
  115. /* Sizes of match buffers for literals/lengths and distances.  There are
  116.  * 4 reasons for limiting LIT_BUFSIZE to 64K:
  117.  *   - frequencies can be kept in 16 bit counters
  118.  *   - if compression is not successful for the first block, all input data is
  119.  *     still in the window so we can still emit a stored block even when input
  120.  *     comes from standard input.  (This can also be done for all blocks if
  121.  *     LIT_BUFSIZE is not greater than 32K.)
  122.  *   - if compression is not successful for a file smaller than 64K, we can
  123.  *     even emit a stored file instead of a stored block (saving 5 bytes).
  124.  *   - creating new Huffman trees less frequently may not provide fast
  125.  *     adaptation to changes in the input data statistics. (Take for
  126.  *     example a binary file with poorly compressible code followed by
  127.  *     a highly compressible string table.) Smaller buffer sizes give
  128.  *     fast adaptation but have of course the overhead of transmitting trees
  129.  *     more frequently.
  130.  *   - I can't count above 4
  131.  * The current code is general and allows DIST_BUFSIZE < LIT_BUFSIZE (to save
  132.  * memory at the expense of compression). Some optimizations would be possible
  133.  * if we rely on DIST_BUFSIZE == LIT_BUFSIZE.
  134.  */
  135.  
  136. #define REP_3_6      16
  137. /* repeat previous bit length 3-6 times (2 bits of repeat count) */
  138.  
  139. #define REPZ_3_10    17
  140. /* repeat a zero length 3-10 times  (3 bits of repeat count) */
  141.  
  142. #define REPZ_11_138  18
  143. /* repeat a zero length 11-138 times  (7 bits of repeat count) */
  144.  
  145. /* Data structure describing a single value and its code string. */
  146. typedef struct ct_data {
  147.     union {
  148.         ush  freq;       /* frequency count */
  149.         ush  code;       /* bit string */
  150.     } fc;
  151.     union {
  152.         ush  dad;        /* father node in Huffman tree */
  153.         ush  len;        /* length of bit string */
  154.     } dl;
  155. } ct_data;
  156.  
  157. #define Freq fc.freq
  158. #define Code fc.code
  159. #define Dad  dl.dad
  160. #define Len  dl.len
  161.  
  162. #define HEAP_SIZE (2*L_CODES+1) /* maximum heap size */
  163.  
  164. static ct_data near dyn_ltree[HEAP_SIZE];   /* literal and length tree */
  165. static ct_data near dyn_dtree[2*D_CODES+1]; /* distance tree */
  166.  
  167. static ct_data near static_ltree[L_CODES+2];
  168. /* The static literal tree. Since the bit lengths are imposed, there is no
  169.  * need for the L_CODES extra codes used during heap construction. However
  170.  * The codes 286 and 287 are needed to build a canonical tree (see ct_init
  171.  * below).
  172.  */
  173.  
  174. static ct_data near static_dtree[D_CODES];
  175. /* The static distance tree. (Actually a trivial tree since all codes use
  176.  * 5 bits.) */
  177.  
  178. static ct_data near bl_tree[2*BL_CODES+1];
  179. /* Huffman tree for the bit lengths */
  180.  
  181. typedef struct tree_desc {
  182.     ct_data near *dyn_tree;      /* the dynamic tree */
  183.     ct_data near *static_tree;   /* corresponding static tree or NULL */
  184.     int     near *extra_bits;    /* extra bits for each code or NULL */
  185.     int     extra_base;          /* base index for extra_bits */
  186.     int     elems;               /* max number of elements in the tree */
  187.     int     max_length;          /* max bit length for the codes */
  188.     int     max_code;            /* largest code with non zero frequency */
  189. } tree_desc;
  190.  
  191. static tree_desc near l_desc =
  192. {dyn_ltree, static_ltree, extra_lbits, LITERALS+1, L_CODES, MAX_BITS, 0};
  193.  
  194. static tree_desc near d_desc =
  195. {dyn_dtree, static_dtree, extra_dbits, 0,          D_CODES, MAX_BITS, 0};
  196.  
  197. static tree_desc near bl_desc =
  198. {bl_tree, (ct_data near*)0, extra_blbits, 0,       BL_CODES, MAX_BL_BITS, 0};
  199.  
  200. static ush near bl_count[MAX_BITS+1];
  201. /* number of codes at each bit length for an optimal tree */
  202.  
  203. static uch near bl_order[BL_CODES]
  204.    = {16,17,18,0,8,7,9,6,10,5,11,4,12,3,13,2,14,1,15};
  205. /* The lengths of the bit length codes are sent in order of decreasing
  206.  * probability, to avoid transmitting the lengths for unused bit length codes.
  207.  */
  208.  
  209. static int near heap[2*L_CODES+1]; /* heap used to build the Huffman trees */
  210. static int heap_len;               /* number of elements in the heap */
  211. static int heap_max;               /* element of largest frequency */
  212. /* The sons of heap[n] are heap[2*n] and heap[2*n+1]. heap[0] is not used.
  213.  * The same heap array is used to build all trees. */
  214.  
  215. static uch near depth[2*L_CODES+1];
  216. /* Depth of each subtree used as tie breaker for trees of equal frequency */
  217.  
  218. static uch length_code[MAX_MATCH-MIN_MATCH+1];
  219. /* length code for each normalized match length (0 == MIN_MATCH) */
  220.  
  221. static uch dist_code[512];
  222. /* distance codes. The first 256 values correspond to the distances
  223.  * 3 .. 258, the last 256 values correspond to the top 8 bits of
  224.  * the 15 bit distances.
  225.  */
  226.  
  227. static int near base_length[LENGTH_CODES];
  228. /* First normalized length for each code (0 = MIN_MATCH) */
  229.  
  230. static int near base_dist[D_CODES];
  231. /* First normalized distance for each code (0 = distance of 1) */
  232.  
  233. #ifndef DYN_ALLOC
  234.   static uch far l_buf[LIT_BUFSIZE];  /* buffer for literals/lengths */
  235.   static ush far d_buf[DIST_BUFSIZE]; /* buffer for distances */
  236. #else
  237.   uch far *l_buf = NULL;
  238.   ush far *d_buf = NULL;
  239. #endif
  240. #ifndef zalloc
  241.    void far *p_l_buf = NULL;
  242.    void far *p_d_buf = NULL;
  243. #else
  244. #  define p_l_buf l_buf
  245. #  define p_d_buf d_buf
  246. #endif
  247.  
  248. static uch near flag_buf[(LIT_BUFSIZE/8)];
  249. /* flag_buf is a bit array distinguishing literals from lengths in
  250.  * l_buf, and thus indicating the presence or absence of a distance.
  251.  */
  252.  
  253. static unsigned last_lit;    /* running index in l_buf */
  254. static unsigned last_dist;   /* running index in d_buf */
  255. static unsigned last_flags;  /* running index in flag_buf */
  256. static uch flags;            /* current flags not yet saved in flag_buf */
  257. static uch flag_bit;         /* current bit used in flags */
  258. /* bits are filled in flags starting at bit 0 (least significant).
  259.  * Note: these flags are overkill in the current code since we don't
  260.  * take advantage of DIST_BUFSIZE == LIT_BUFSIZE.
  261.  */
  262.  
  263. static ulg opt_len;        /* bit length of current block with optimal trees */
  264. static ulg static_len;     /* bit length of current block with static trees */
  265.        ulg compressed_len; /* total bit length of compressed file */
  266. static ulg input_len;      /* total byte length of input file */
  267. /* input_len is for debugging only since we can get it by other means. */
  268.  
  269. #ifdef DEBUG
  270. extern ulg bits_sent;  /* bit length of the compressed data */
  271. extern ulg isize;      /* byte length of input file */
  272. #endif
  273.  
  274. extern long block_start;       /* window offset of current block */
  275. extern unsigned near strstart; /* window offset of current string */
  276.  
  277. static unsigned reverse    OF((unsigned, int));
  278. static void init_block     OF((void));
  279. static void pqdownheap     OF((ct_data near *tree, int k));
  280. static void gen_bitlen     OF((tree_desc near *desc));
  281. static void gen_codes      OF((ct_data near *tree, int max_code));
  282. static void build_tree     OF((tree_desc near *desc));
  283. static void scan_tree      OF((ct_data near *tree, int max_code));
  284. static void send_tree      OF((ct_data near *tree, int max_code));
  285. static int  build_bl_tree  OF((void));
  286. static void send_all_trees OF((int lcodes, int dcodes, int blcodes));
  287. static void compress_block OF((ct_data near *ltree, ct_data near *dtree));
  288.  
  289. #ifndef DEBUG
  290. #  define send_code(c, tree) send_bits(tree[c].Code, tree[c].Len)
  291.    /* Send a code of the given tree. c and tree must not have side effects */
  292.  
  293. #else /* DEBUG */
  294. #  define send_code(c, tree) \
  295.      { if (verbose>1) fprintf(stderr,"\ncd %3d ",(c)); \
  296.        send_bits(tree[c].Code, tree[c].Len); }
  297. #endif
  298.  
  299. #define d_code(dist) \
  300.    ((dist) < 256 ? dist_code[dist] : dist_code[256+((dist)>>7)])
  301. /* Mapping from a distance to a distance code. dist is the distance - 1 and
  302.  * must not have side effects. dist_code[256] and dist_code[257] are never
  303.  * used. */
  304.  
  305. #define MAX(a,b) (a >= b ? a : b)
  306. /* the arguments must not have side effects */
  307.  
  308. #ifdef DYN_ALLOC
  309. void ct_free()
  310. {
  311.    if (p_d_buf) { zfree(p_d_buf); p_d_buf = NULL; }
  312.    if (p_l_buf) { zfree(p_l_buf); p_l_buf = NULL; }
  313. }
  314.  
  315. int ct_alloc()
  316. {
  317.    if (!p_d_buf) {
  318.       d_buf = (ush far*)zalloc(&p_d_buf, DIST_BUFSIZE, sizeof(ush));
  319.       if (!p_d_buf) return ZNOMEM;
  320.    }
  321.    if (!p_l_buf) {
  322.       /* Avoid using the value 64K on 16 bit machines */
  323.       l_buf = (uch far*)zalloc(&p_l_buf, LIT_BUFSIZE/2, 2);
  324.       if (!p_l_buf) {
  325.          ct_free(); return ZNOMEM;
  326.       }
  327.    }
  328.    return 0;
  329. }
  330. #endif
  331.  
  332. static unsigned reverse(code, len)
  333. /* Reverse the first len bits of a code. */
  334. unsigned code; /* the value to invert */
  335. int len;       /* its bit length: 1 =< len =< 15 */
  336. {
  337.    register unsigned res = 0;
  338.    do res = (res << 1) | (code & 1), code>>=1; while (--len);
  339.    return res;
  340. }
  341.  
  342. /* Allocate the match buffer and initialize the various tables. */
  343. int ct_init()
  344. {
  345.    register n;    /* iterates over tree elements */
  346.    int bits;      /* bit counter */
  347.    int length;    /* length value */
  348.    register code; /* code value */
  349.    int dist;      /* distance index */
  350.  
  351.     compressed_len = input_len = 0L;
  352.  
  353. #ifdef DYN_ALLOC
  354.    if (ct_alloc() != 0) return ZNOMEM;
  355. #endif
  356.    if (static_dtree[0].Len != 0) return 0; /* ct_init already called */
  357.  
  358.    /* Initialize the mapping length (0..255) -> length code (0..28) */
  359.    length = 0;
  360.    for (code=0; code < LENGTH_CODES-1; code++) {
  361.       base_length[code] = length;
  362.       for (n=0; n < (1<<extra_lbits[code]); n++) {
  363.          length_code[length++] = (uch)code;
  364.       }
  365.    }
  366.    Assert (length == 256, "ct_init: length != 256");
  367.     /* Note that the length 255 (match length 258) can be represented
  368.        in two different ways: code 284 + 5 bits or code 285, so we
  369.        overwrite length_code[255] to use the best encoding:     */
  370.    length_code[length-1] = (uch)code;
  371.  
  372.    /* Initialize the mapping dist (0..32K) -> dist code (0..29) */
  373.    dist = 0;
  374.    for (code=0 ; code < 16; code++) {
  375.       base_dist[code] = dist;
  376.       for (n=0; n < (1<<extra_dbits[code]); n++) {
  377.          dist_code[dist++] = (uch)code;
  378.       }
  379.    }
  380.    Assert (dist == 256, "ct_init: dist != 256");
  381.    dist >>= 7; /* from now on, all distances are divided by 128 */
  382.    for (; code < D_CODES; code++) {
  383.       base_dist[code] = dist << 7;
  384.       for (n=0; n < (1<<(extra_dbits[code]-7)); n++) {
  385.          dist_code[256 + dist++] = (uch)code;
  386.       }
  387.    }
  388.    Assert (dist == 256, "ct_init: 256+dist != 512");
  389.  
  390.    /* Construct the codes of the static literal tree */
  391.    for (bits=0; bits <= MAX_BITS; bits++) bl_count[bits] = 0;
  392.    n = 0;
  393.    while (n <= 143) static_ltree[n++].Len = 8, bl_count[8]++;
  394.    while (n <= 255) static_ltree[n++].Len = 9, bl_count[9]++;
  395.    while (n <= 279) static_ltree[n++].Len = 7, bl_count[7]++;
  396.    while (n <= 287) static_ltree[n++].Len = 8, bl_count[8]++;
  397.    /* Codes 286 and 287 do not exist, but we must include them in the tree
  398.       construction to get a canonical Huffman tree (longest code all ones) */
  399.    gen_codes((ct_data near *)static_ltree, L_CODES+1);
  400.  
  401.    /* The static distance tree is trivial: */
  402.    for (n=0; n < D_CODES; n++) {
  403.       static_dtree[n].Len = 5;
  404.       static_dtree[n].Code = reverse(n, 5);
  405.    }
  406.  
  407.    /* Initialize the first block of the first file: */
  408.    init_block();
  409.    return 0;
  410. }
  411.  
  412. /* Initialize a new block. */
  413. static void init_block()
  414. {
  415.    register n; /* iterates over tree elements */
  416.  
  417.    /* Initialize the trees. */
  418.    for (n=0; n < L_CODES;  n++) dyn_ltree[n].Freq = 0;
  419.    for (n=0; n < D_CODES;  n++) dyn_dtree[n].Freq = 0;
  420.    for (n=0; n < BL_CODES; n++) bl_tree[n].Freq = 0;
  421.  
  422.    dyn_ltree[END_BLOCK].Freq = 1;
  423.    opt_len = static_len = 0L;
  424.    last_lit = last_dist = last_flags = 0;
  425.    flags = 0; flag_bit = 1;
  426. }
  427.  
  428. #define SMALLEST 1
  429. /* Index within the heap array of least frequent node in the Huffman tree */
  430.  
  431. /*
  432.  * Remove the smallest element from the heap and recreate the heap with
  433.  * one less element. Updates heap and heap_len.
  434.  */
  435. #define pqremove(tree, top) \
  436. {\
  437.     top = heap[SMALLEST]; \
  438.     heap[SMALLEST] = heap[heap_len--]; \
  439.     pqdownheap(tree, SMALLEST); \
  440. }
  441.  
  442. /*
  443.  * Compares to subtrees, using the tree depth as tie breaker when
  444.  * the subtrees have equal frequency. This minimizes the worst case length.
  445.  */
  446. #define smaller(tree, n, m) \
  447.    (tree[n].Freq < tree[m].Freq || \
  448.    (tree[n].Freq == tree[m].Freq && depth[n] <= depth[m]))
  449.  
  450. /*
  451.  * Restore the heap property by moving down the tree starting at node k,
  452.  * exchanging a node with the smallest of its two sons if necessary, stopping
  453.  * when the heap property is re-established (each father smaller than its
  454.  * two sons).
  455.  */
  456. static void pqdownheap(tree, k)
  457.     ct_data near *tree;  /* the tree to restore */
  458.     int k;               /* node to move down */
  459. {
  460.     int v = heap[k];
  461.     int j = k << 1;  /* left son of k */
  462.     int htemp;       /* required because of bug in SASC compiler */
  463.  
  464.     while (j <= heap_len) {
  465.         /* Set j to the smallest of the two sons: */
  466.         if (j < heap_len && smaller(tree, heap[j+1], heap[j])) j++;
  467.  
  468.         /* Exit if v is smaller than both sons */
  469.         htemp = heap[j];
  470.         if (smaller(tree, v, htemp)) break;
  471.  
  472.         /* Exchange v with the smallest son */
  473.         heap[k] = htemp;
  474.         k = j;
  475.  
  476.         /* And continue down the tree, setting j to the left son of k */
  477.         j <<= 1;
  478.     }
  479.     heap[k] = v;
  480. }
  481.  
  482. /*
  483.  * Compute the optimal bit lengths for a tree and update the total bit length
  484.  * for the current block.
  485.  * IN assertion: the fields freq and dad are set, heap[heap_max] and
  486.  *    above are the tree nodes sorted by increasing frequency.
  487.  * OUT assertions: the field len is set to the optimal bit length, the
  488.  *     array bl_count contains the frequencies for each bit length.
  489.  *     The length opt_len is updated; static_len is also updated if stree is
  490.  *     not null.
  491.  */
  492. static void gen_bitlen(desc)
  493.     tree_desc near *desc; /* the tree descriptor */
  494. {
  495.     ct_data near *tree  = desc->dyn_tree;
  496.     int near *extra     = desc->extra_bits;
  497.     int base            = desc->extra_base;
  498.     int max_code        = desc->max_code;
  499.     int max_length      = desc->max_length;
  500.     ct_data near *stree = desc->static_tree;
  501.     int h;              /* heap index */
  502.     int n, m;           /* iterate over the tree elements */
  503.     int bits;           /* bit length */
  504.     int xbits;          /* extra bits */
  505.     ush f;              /* frequency */
  506.     int overflow = 0;   /* number of elements with bit length too large */
  507.  
  508.     for (bits = 0; bits <= MAX_BITS; bits++) bl_count[bits] = 0;
  509.  
  510.     /* In a first pass, compute the optimal bit lengths (which may
  511.      * overflow in the case of the bit length tree).
  512.      */
  513.     tree[heap[heap_max]].Len = 0; /* root of the heap */
  514.  
  515.     for (h = heap_max+1; h < HEAP_SIZE; h++) {
  516.         n = heap[h];
  517.         bits = tree[tree[n].Dad].Len + 1;
  518.         if (bits > max_length) bits = max_length, overflow++;
  519.         tree[n].Len = bits;
  520.         /* We overwrite tree[n].Dad which is no longer needed */
  521.  
  522.         if (n > max_code) continue; /* not a leaf node */
  523.  
  524.         bl_count[bits]++;
  525.         xbits = 0;
  526.         if (n >= base) xbits = extra[n-base];
  527.         f = tree[n].Freq;
  528.         opt_len += (ulg)f * (bits + xbits);
  529.         if (stree) static_len += (ulg)f * (stree[n].Len + xbits);
  530.     }
  531.     if (overflow == 0) return;
  532.  
  533.     Trace((stderr,"\nbit length overflow\n"));
  534.     /* This happens for example on obj2 and pic of the Calgary corpus */
  535.  
  536.     /* Find the first bit length which could increase: */
  537.     do {
  538.         bits = max_length-1;
  539.         while (bl_count[bits] == 0) bits--;
  540.         bl_count[bits]--;      /* move one leaf down the tree */
  541.         bl_count[bits+1] += 2; /* move one overflow item as its brother */
  542.         bl_count[max_length]--;
  543.         /* The brother of the overflow item also moves one step up,
  544.          * but this does not affect bl_count[max_length]
  545.          */
  546.         overflow -= 2;
  547.     } while (overflow > 0);
  548.  
  549.     /* Now recompute all bit lengths, scanning in increasing frequency.
  550.      * h is still equal to HEAP_SIZE. (It is simpler to reconstruct all
  551.      * lengths instead of fixing only the wrong ones. This idea is taken
  552.      * from 'ar' written by Haruhiko Okumura.)
  553.      */
  554.     for (bits = max_length; bits != 0; bits--) {
  555.         n = bl_count[bits];
  556.         while (n != 0) {
  557.             m = heap[--h];
  558.             if (m > max_code) continue;
  559.             if (tree[m].Len != (unsigned) bits) {
  560.                 Trace((stderr,"code %d bits %d->%d\n", m, tree[m].Len, bits));
  561.                 opt_len += ((long)bits-(long)tree[m].Len)*(long)tree[m].Freq;
  562.                 tree[m].Len = bits;
  563.             }
  564.             n--;
  565.         }
  566.     }
  567. }
  568.  
  569. /*
  570.  * Generate the codes for a given tree and bit counts (which need not be
  571.  * optimal).
  572.  * IN assertion: the array bl_count contains the bit length statistics for
  573.  * the given tree and the field len is set for all tree elements.
  574.  * OUT assertion: the field code is set for all tree elements of non
  575.  *     zero code length.
  576.  */
  577. static void gen_codes (tree, max_code)
  578.     ct_data near *tree;        /* the tree to decorate */
  579.     int max_code;              /* largest code with non zero frequency */
  580. {
  581.     ush next_code[MAX_BITS+1]; /* next code value for each bit length */
  582.     ush code = 0;              /* running code value */
  583.     int bits;                  /* bit index */
  584.     int n;                     /* code index */
  585.  
  586.     /* The distribution counts are first used to generate the code values
  587.      * without bit reversal.
  588.      */
  589.     for (bits = 1; bits <= MAX_BITS; bits++) {
  590.         next_code[bits] = code = (code + bl_count[bits-1]) << 1;
  591.     }
  592.     /* Check that the bit counts in bl_count are consistent. The last code
  593.      * must be all ones.
  594.      */
  595.     Assert (code + bl_count[MAX_BITS]-1 == (1<<MAX_BITS)-1,
  596.             "inconsistent bit counts");
  597.     Tracev((stderr,"\ngen_codes: max_code %d ", max_code));
  598.  
  599.     for (n = 0;  n <= max_code; n++) {
  600.         int len = tree[n].Len;
  601.         if (len == 0) continue;
  602.         /* Now reverse the bits */
  603.         tree[n].Code = reverse(next_code[len]++, len);
  604.  
  605.         Tracec(tree != static_ltree, (stderr,"\nn %3d %c l %2d c %4x (%x) ",
  606.              n, (isgraph(n) ? n : ' '), len, tree[n].Code, next_code[len]-1));
  607.     }
  608. }
  609.  
  610. /*
  611.  * Construct one Huffman tree and assigns the code bit strings and lengths.
  612.  * Update the total bit length for the current block.
  613.  * IN assertion: the field freq is set for all tree elements.
  614.  * OUT assertions: the fields len and code are set to the optimal bit length
  615.  *     and corresponding code. The length opt_len is updated; static_len is
  616.  *     also updated if stree is not null. The field max_code is set.
  617.  */
  618. static void build_tree(desc)
  619.     tree_desc near *desc; /* the tree descriptor */
  620. {
  621.     ct_data near *tree   = desc->dyn_tree;
  622.     ct_data near *stree  = desc->static_tree;
  623.     int elems            = desc->elems;
  624.     int n, m;          /* iterate over heap elements */
  625.     int max_code = -1; /* largest code with non zero frequency */
  626.     int node = elems;  /* next internal node of the tree */
  627.  
  628.     /* Construct the initial heap, with least frequent element in
  629.      * heap[SMALLEST]. The sons of heap[n] are heap[2*n] and heap[2*n+1].
  630.      * heap[0] is not used.
  631.      */
  632.     heap_len = 0, heap_max = HEAP_SIZE;
  633.  
  634.     for (n = 0; n < elems; n++) {
  635.         if (tree[n].Freq != 0) {
  636.             heap[++heap_len] = max_code = n;
  637.             depth[n] = 0;
  638.         } else {
  639.             tree[n].Len = 0;
  640.         }
  641.     }
  642.  
  643.     /* The pkzip format requires that at least one distance code exists,
  644.      * and that at least one bit should be sent even if there is only one
  645.      * possible code. So to avoid special checks later on we force at least
  646.      * two codes of non zero frequency.
  647.      */
  648.     while (heap_len < 2) {
  649.         int new = heap[++heap_len] = (max_code < 2 ? ++max_code : 0);
  650.         tree[new].Freq = 1;
  651.         depth[new] = 0;
  652.         opt_len--; if (stree) static_len -= stree[new].Len;
  653.         /* new is 0 or 1 so it does not have extra bits */
  654.     }
  655.     desc->max_code = max_code;
  656.  
  657.     /* The elements heap[heap_len/2+1 .. heap_len] are leaves of the tree,
  658.      * establish sub-heaps of increasing lengths:
  659.      */
  660.     for (n = heap_len/2; n >= 1; n--) pqdownheap(tree, n);
  661.  
  662.     /* Construct the Huffman tree by repeatedly combining the least two
  663.      * frequent nodes.
  664.      */
  665.     do {
  666.         pqremove(tree, n);   /* n = node of least frequency */
  667.         m = heap[SMALLEST];  /* m = node of next least frequency */
  668.  
  669.         heap[--heap_max] = n; /* keep the nodes sorted by frequency */
  670.         heap[--heap_max] = m;
  671.  
  672.         /* Create a new node father of n and m */
  673.         tree[node].Freq = tree[n].Freq + tree[m].Freq;
  674.         depth[node] = (uch) (MAX(depth[n], depth[m]) + 1);
  675.         tree[n].Dad = tree[m].Dad = node;
  676. #ifdef DUMP_BL_TREE
  677.         if (tree == bl_tree) {
  678.             fprintf(stderr,"\nnode %d(%d), sons %d(%d) %d(%d)",
  679.                     node, tree[node].Freq, n, tree[n].Freq, m, tree[m].Freq);
  680.         }
  681. #endif
  682.         /* and insert the new node in the heap */
  683.         heap[SMALLEST] = node++;
  684.         pqdownheap(tree, SMALLEST);
  685.  
  686.     } while (heap_len >= 2);
  687.  
  688.     heap[--heap_max] = heap[SMALLEST];
  689.  
  690.     /* At this point, the fields freq and dad are set. We can now
  691.      * generate the bit lengths.
  692.      */
  693.     gen_bitlen((tree_desc near *)desc);
  694.  
  695.     /* The field len is now set, we can generate the bit codes */
  696.     gen_codes ((ct_data near *)tree, max_code);
  697. }
  698.  
  699. /* ===========================================================================
  700.  * Scan a literal or distance tree to determine the frequencies of the codes
  701.  * in the bit length tree. Updates opt_len to take into account the repeat
  702.  * counts. (The contribution of the bit length codes will be added later
  703.  * during the construction of bl_tree.)
  704.  */
  705. static void scan_tree (tree, max_code)
  706.     ct_data near *tree; /* the tree to be scanned */
  707.     int max_code;       /* and its largest code of non zero frequency */
  708. {
  709.     int n;                     /* iterates over all tree elements */
  710.     int prevlen = -1;          /* last emitted length */
  711.     int curlen;                /* length of current code */
  712.     int nextlen = tree[0].Len; /* length of next code */
  713.     int count = 0;             /* repeat count of the current code */
  714.     int max_count = 7;         /* max repeat count */
  715.     int min_count = 4;         /* min repeat count */
  716.  
  717.     if (nextlen == 0) max_count = 138, min_count = 3;
  718.     tree[max_code+1].Len = (ush)-1; /* guard */
  719.  
  720.     for (n = 0; n <= max_code; n++) {
  721.         curlen = nextlen; nextlen = tree[n+1].Len;
  722.         if (++count < max_count && curlen == nextlen) {
  723.             continue;
  724.         } else if (count < min_count) {
  725.             bl_tree[curlen].Freq += count;
  726.         } else if (curlen != 0) {
  727.             if (curlen != prevlen) bl_tree[curlen].Freq++;
  728.             bl_tree[REP_3_6].Freq++;
  729.         } else if (count <= 10) {
  730.             bl_tree[REPZ_3_10].Freq++;
  731.         } else {
  732.             bl_tree[REPZ_11_138].Freq++;
  733.         }
  734.         count = 0; prevlen = curlen;
  735.         if (nextlen == 0) {
  736.             max_count = 138, min_count = 3;
  737.         } else if (curlen == nextlen) {
  738.             max_count = 6, min_count = 3;
  739.         } else {
  740.             max_count = 7, min_count = 4;
  741.         }
  742.     }
  743. }
  744.  
  745. /* ===========================================================================
  746.  * Send a literal or distance tree in compressed form, using the codes in
  747.  * bl_tree.
  748.  */
  749. static void send_tree (tree, max_code)
  750.     ct_data near *tree; /* the tree to be scanned */
  751.     int max_code;       /* and its largest code of non zero frequency */
  752. {
  753.     int n;                     /* iterates over all tree elements */
  754.     int prevlen = -1;          /* last emitted length */
  755.     int curlen;                /* length of current code */
  756.     int nextlen = tree[0].Len; /* length of next code */
  757.     int count = 0;             /* repeat count of the current code */
  758.     int max_count = 7;         /* max repeat count */
  759.     int min_count = 4;         /* min repeat count */
  760.  
  761.     /* tree[max_code+1].Len = -1; */  /* guard already set */
  762.     if (nextlen == 0) max_count = 138, min_count = 3;
  763.  
  764.     for (n = 0; n <= max_code; n++) {
  765.         curlen = nextlen; nextlen = tree[n+1].Len;
  766.         if (++count < max_count && curlen == nextlen) {
  767.             continue;
  768.         } else if (count < min_count) {
  769.             do { send_code(curlen, bl_tree); } while (--count != 0);
  770.  
  771.         } else if (curlen != 0) {
  772.             if (curlen != prevlen) {
  773.                 send_code(curlen, bl_tree); count--;
  774.             }
  775.             Assert(count >= 3 && count <= 6, " 3_6?");
  776.             send_code(REP_3_6, bl_tree); send_bits(count-3, 2);
  777.  
  778.         } else if (count <= 10) {
  779.             send_code(REPZ_3_10, bl_tree); send_bits(count-3, 3);
  780.  
  781.         } else {
  782.             send_code(REPZ_11_138, bl_tree); send_bits(count-11, 7);
  783.         }
  784.         count = 0; prevlen = curlen;
  785.         if (nextlen == 0) {
  786.             max_count = 138, min_count = 3;
  787.         } else if (curlen == nextlen) {
  788.             max_count = 6, min_count = 3;
  789.         } else {
  790.             max_count = 7, min_count = 4;
  791.         }
  792.     }
  793. }
  794.  
  795. /* ===========================================================================
  796.  * Construct the Huffman tree for the bit lengths and return the index in
  797.  * bl_order of the last bit length code to send.
  798.  */
  799. static int build_bl_tree()
  800. {
  801.     int max_blindex;  /* index of last bit length code of non zero freq */
  802.  
  803.     /* Determine the bit length frequencies for literal and distance trees */
  804.     scan_tree((ct_data near *)dyn_ltree, l_desc.max_code);
  805.     scan_tree((ct_data near *)dyn_dtree, d_desc.max_code);
  806.  
  807.     /* Build the bit length tree: */
  808.     build_tree((tree_desc near *)(&bl_desc));
  809.     /* opt_len now includes the length of the tree representations, except
  810.      * the lengths of the bit lengths codes and the 5+5+4 bits for the counts.
  811.      */
  812.  
  813.     /* Determine the number of bit length codes to send. The pkzip format
  814.      * requires that at least 4 bit length codes be sent. (appnote.txt says
  815.      * 3 but the actual value used is 4.)
  816.      */
  817.     for (max_blindex = BL_CODES-1; max_blindex >= 3; max_blindex--) {
  818.         if (bl_tree[bl_order[max_blindex]].Len != 0) break;
  819.     }
  820.     /* Update opt_len to include the bit length tree and counts */
  821.     opt_len += 3*(max_blindex+1) + 5+5+4;
  822.     Tracev((stderr, "\ndyn trees: dyn %ld, stat %ld", opt_len, static_len));
  823.  
  824.     return max_blindex;
  825. }
  826.  
  827. /* ===========================================================================
  828.  * Send the header for a block using dynamic Huffman trees: the counts, the
  829.  * lengths of the bit length codes, the literal tree and the distance tree.
  830.  * IN assertion: lcodes >= 257, dcodes >= 1, blcodes >= 4.
  831.  */
  832. static void send_all_trees(lcodes, dcodes, blcodes)
  833.     int lcodes, dcodes, blcodes; /* number of codes for each tree */
  834. {
  835.     int rank;                    /* index in bl_order */
  836.  
  837.     Assert (lcodes >= 257 && dcodes >= 1 && blcodes >= 4, "not enough codes");
  838.     Assert (lcodes <= L_CODES && dcodes <= D_CODES && blcodes <= BL_CODES,
  839.             "too many codes");
  840.     Tracev((stderr, "\nbl counts: "));
  841.     send_bits(lcodes-257, 5);
  842.     /* not +255 as stated in appnote.txt 1.93a or -256 in 2.04c */
  843.     send_bits(dcodes-1,   5);
  844.     send_bits(blcodes-4,  4); /* not -3 as stated in appnote.txt */
  845.     for (rank = 0; rank < blcodes; rank++) {
  846.         Tracev((stderr, "\nbl code %2d ", bl_order[rank]));
  847.         send_bits(bl_tree[bl_order[rank]].Len, 3);
  848.     }
  849.     Tracev((stderr, "\nbl tree: sent %ld", bits_sent));
  850.  
  851.     send_tree((ct_data near *)dyn_ltree, lcodes-1); /* send the literal tree */
  852.     Tracev((stderr, "\nlit tree: sent %ld", bits_sent));
  853.  
  854.     send_tree((ct_data near *)dyn_dtree, dcodes-1); /* send the distance tree */
  855.     Tracev((stderr, "\ndist tree: sent %ld", bits_sent));
  856. }
  857.  
  858. /* ===========================================================================
  859.  * Determine the best encoding for the current block: dynamic trees, static
  860.  * trees or store, and output the encoded block to the zip file. This function
  861.  * returns the total compressed length for the file so far.
  862.  */
  863. ulg flush_block(buf, stored_len, eof)
  864. char far *buf;    /* input block, or NULL if too old */
  865. ulg stored_len;   /* length of input block */
  866. int eof;          /* true if this is the last block for a file */
  867. {
  868.     ulg opt_lenb, static_lenb; /* opt_len and static_len in bytes */
  869.     int max_blindex;  /* index of last bit length code of non zero freq */
  870.  
  871.     flag_buf[last_flags] = flags; /* Save the flags for the last 8 items */
  872.  
  873.     /* Construct the literal and distance trees */
  874.     build_tree((tree_desc near *)(&l_desc));
  875.     Tracev((stderr, "\nlit data: dyn %ld, stat %ld", opt_len, static_len));
  876.  
  877.     build_tree((tree_desc near *)(&d_desc));
  878.     Tracev((stderr, "\ndist data: dyn %ld, stat %ld", opt_len, static_len));
  879.     /* At this point, opt_len and static_len are the total bit lengths of
  880.      * the compressed block data, excluding the tree representations.
  881.      */
  882.  
  883.     /* Build the bit length tree for the above two trees, and get the index
  884.      * in bl_order of the last bit length code to send.
  885.      */
  886.     max_blindex = build_bl_tree();
  887.  
  888.     /* Determine the best encoding. Compute first the block length in bytes */
  889.     opt_lenb = (opt_len+3+7)>>3;
  890.     static_lenb = (static_len+3+7)>>3;
  891.     input_len += stored_len; /* for debugging only */
  892.  
  893.     Trace((stderr, "\nopt %lu(%lu) stat %lu(%lu) stored %lu lit %u dist %u ",
  894.             opt_lenb, opt_len, static_lenb, static_len, stored_len,
  895.             last_lit, last_dist));
  896.  
  897.     if (static_lenb <= opt_lenb) opt_lenb = static_lenb;
  898.  
  899. #ifdef FORCE_METHOD
  900.     if (level == 2 && buf) /* force stored block */
  901. #else
  902.     if (stored_len+4 <= opt_lenb && buf) /* 4: two words for the lengths */
  903. #endif
  904.     {
  905.         /* The test buf != NULL is only necessary if LIT_BUFSIZE > WSIZE.
  906.          * Otherwise we can't have processed more than WSIZE input bytes since
  907.          * the last block flush, because compression would have been
  908.          * successful. If LIT_BUFSIZE <= WSIZE, it is never too late to
  909.          * transform a block into a stored block.
  910.          */
  911.         send_bits((STORED_BLOCK<<1)+eof, 3);  /* send block type */
  912.         compressed_len = (compressed_len + 3 + 7) & ~7L;
  913.         compressed_len += (stored_len + 4) << 3;
  914.  
  915.         copy_block(buf, (unsigned)stored_len, 1); /* with header */
  916.     }
  917. #ifdef FORCE_METHOD
  918.     else if (level == 3) /* force static trees */
  919. #else
  920.     else if (static_lenb == opt_lenb)
  921. #endif
  922.     {
  923.         send_bits((STATIC_TREES<<1)+eof, 3);
  924.         compress_block((ct_data near *)static_ltree, (ct_data near *)static_dtree);
  925.         compressed_len += 3 + static_len;
  926.     } else {
  927.         send_bits((DYN_TREES<<1)+eof, 3);
  928.         send_all_trees(l_desc.max_code+1, d_desc.max_code+1, max_blindex+1);
  929.         compress_block((ct_data near *)dyn_ltree, (ct_data near *)dyn_dtree);
  930.         compressed_len += 3 + opt_len;
  931.     }
  932.     Assert (compressed_len == bits_sent, "bad compressed size");
  933.     init_block();
  934.  
  935.     if (eof) {
  936.         Assert (input_len == isize, "bad input size");
  937.         bi_windup();
  938.         compressed_len += 7;  /* align on byte boundary */
  939.     }
  940.     Tracev((stderr,"\ncomprlen %lu(%lu) ", compressed_len>>3,
  941.            compressed_len-7*eof));
  942.  
  943.     return compressed_len >> 3;
  944. }
  945.  
  946. /* Save the match info and tally the frequency counts.
  947.    Return true if the current block must be flushed. */
  948. int ct_tally (dist, lc)
  949.     int dist;  /* distance of matched string */
  950.     int lc;    /* match length-MIN_MATCH or unmatched char (if dist==0) */
  951. {
  952.     l_buf[last_lit++] = (uch)lc;
  953.     if (dist == 0) {
  954.         /* lc is the unmatched char */
  955.         dyn_ltree[lc].Freq++;
  956.     } else {
  957.         /* Here, lc is the match length - MIN_MATCH */
  958.         dist--;             /* dist = match distance - 1 */
  959.         Assert((ush)dist < (ush)MAX_DIST &&
  960.                (ush)lc <= (ush)(MAX_MATCH-MIN_MATCH) &&
  961.                (ush)d_code(dist) < (ush)D_CODES,  "ct_tally: bad match");
  962.  
  963.         dyn_ltree[length_code[lc]+LITERALS+1].Freq++;
  964.         dyn_dtree[d_code(dist)].Freq++;
  965.  
  966.         d_buf[last_dist++] = dist;
  967.         flags |= flag_bit;
  968.     }
  969.     flag_bit <<= 1;
  970.  
  971.     /* Output the flags if they fill a byte: */
  972.     if ((last_lit & 7) == 0) {
  973.         flag_buf[last_flags++] = flags;
  974.         flags = 0, flag_bit = 1;
  975.     }
  976.     /* Try to guess if it is profitable to stop the current block here */
  977.     if (deflate_level > 2 && (last_lit & 0xfff) == 0) {
  978.         /* Compute an upper bound for the compressed length */
  979.         ulg out_length = (ulg)last_lit*8L;
  980.         ulg in_length = (ulg)strstart-block_start;
  981.         int dcode;
  982.         for (dcode = 0; dcode < D_CODES; dcode++) {
  983.             out_length += (ulg)dyn_dtree[dcode].Freq*(5L+extra_dbits[dcode]);
  984.         }
  985.         out_length >>= 3;
  986.         Trace((stderr,"\nlast_lit %u, last_dist %u, in %ld, out ~%ld(%ld%%) ",
  987.                last_lit, last_dist, in_length, out_length,
  988.                100L - out_length*100L/in_length));
  989.         if (last_dist < last_lit/2 && out_length < in_length/2) return 1;
  990.     }
  991.     return (last_lit == LIT_BUFSIZE-1 || last_dist == DIST_BUFSIZE);
  992.     /* We avoid equality with LIT_BUFSIZE because of wraparound at 64K
  993.      * on 16 bit machines and because stored blocks are restricted to
  994.      * 64K-1 bytes.
  995.      */
  996. }
  997.  
  998. /* ===========================================================================
  999.  * Send the block data compressed using the given Huffman trees
  1000.  */
  1001. static void compress_block(ltree, dtree)
  1002. ct_data near *ltree; /* literal tree */
  1003. ct_data near *dtree; /* distance tree */
  1004. {
  1005.     unsigned dist;      /* distance of matched string */
  1006.     int lc;             /* match length or unmatched char (if dist == 0) */
  1007.     unsigned lx = 0;    /* running index in l_buf */
  1008.     unsigned dx = 0;    /* running index in d_buf */
  1009.     unsigned fx = 0;    /* running index in flag_buf */
  1010.     uch flag = 0;       /* current flags */
  1011.     unsigned code;      /* the code to send */
  1012.     int extra;          /* number of extra bits to send */
  1013.  
  1014.     if (last_lit != 0) do {
  1015.         if ((lx & 7) == 0) flag = flag_buf[fx++];
  1016.         lc = l_buf[lx++];
  1017.         if ((flag & 1) == 0) {
  1018.             send_code(lc, ltree); /* send a literal byte */
  1019.             Tracecv(isgraph(lc), (stderr," '%c' ", lc));
  1020.         } else {
  1021.             /* Here, lc is the match length - MIN_MATCH */
  1022.             code = length_code[lc];
  1023.             send_code(code+LITERALS+1, ltree); /* send the length code */
  1024.             extra = extra_lbits[code];
  1025.             if (extra != 0) {
  1026.                 lc -= base_length[code];
  1027.                 send_bits(lc, extra);        /* send the extra length bits */
  1028.             }
  1029.             dist = d_buf[dx++];
  1030.             /* Here, dist is the match distance - 1 */
  1031.             code = d_code(dist);
  1032.             Assert (code < D_CODES, "bad d_code");
  1033.  
  1034.             send_code(code, dtree);       /* send the distance code */
  1035.             extra = extra_dbits[code];
  1036.             if (extra != 0) {
  1037.                 dist -= base_dist[code];
  1038.                 send_bits(dist, extra);   /* send the extra distance bits */
  1039.             }
  1040.         } /* literal or match pair ? */
  1041.         flag >>= 1;
  1042.     } while (lx < last_lit);
  1043.  
  1044.     send_code(END_BLOCK, ltree);
  1045. }
  1046.